QuerySubscription

The QuerySubscription web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to query a Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription and retrieve Subscription Summary details for any existing CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Subscription.

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Subscription Number, or Primary Serial Number, (for example, mobile number) in order to retrieve the associated Subscription details.

The client can pass in one of more datasets to retrieve a specific subset of information. For example:

Address
Bars
Serial Numbers
Discounts
Services
Billing Media
Contract and Sales
Customer In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement. Details
Usage and Credit Control

Submitting invalid data in the request will result in an error message. When calling the web service, the derived data (such as the balance) and the description fields are not returned. Only the associated codes are returned.

QuerySubscription Request

The QuerySubscription tag instructs the Subscription Service to query a Subscription. This request contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

SubscriptionQueryData

Container

Choice of:

SubscriptionNumber (Integer8)
PrimarySerialNumber, e.g. Mobile Number (String25)

Mandatory

Datasets

Container

Contains one or more Subscription Dataset(s):

ACTIVE_AND_PENDING_SERVICES
ADDRESS
ATTRIBUTES
BASIC
BILLINGMEDIA
CONTRACTANDSALES
CUSTOMERDETAILS
DEFINITIONS
DISCOUNTS
FEATURES
PENDING_TARIFF_CHANGE
SERIALNUMBERS
SERVICES
SIM_PROFILE_INFORMATION
SUBSCRIPTIONBARS
TERMINATION_FEE
USAGEANDCREDITCONTROL

Mandatory

Sample QuerySubscription Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/subscription/definition">

<soapenv:Header/>

<soapenv:Body>

<def:QuerySubscription>

<def:Request>

</SubscriptionQueryData>

<Dataset>BASIC</Dataset>

<Dataset>ATTRIBUTES</Dataset>

<Dataset>CUSTOMERDETAILS</Dataset>

<Dataset>SERVICES</Dataset>

</Datasets>

</def:Request>

</def:QuerySubscription>

</soapenv:Body>

</soapenv:Envelope>

QuerySubscription Response

The QuerySubscription response is the response to the QuerySubscription Details Request. This contains the following Result elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
SubscriptionBasic	Container	From Basic Dataset in request. See SubscriptionBasic Response Container for details.	Optional
CustomerDetails	Container	From Customer Details Dataset in request. See CustomerDetails Response Container for details.	Optional
ContractAndSales	Container	From Contract and Sales Dataset in request. See ContractAndSales Response Container for details.	Optional
ManagedSerialNumber	Container	From Serial Numbers Dataset in request. A Container for one or more Managed Serial Numbers. See ManagedSerialNumbers Response Container for details.	Optional
NonManagedSerialNumbers	Container	From Serial Numbers Dataset in request. A Container for one or more Non-Managed Serial Numbers. See NonManagedSerialNumbers Response Container for details.	Optional
NetworkSubCodes	Container	From Serial Numbers Dataset in request. A Container for one or more Network Sub Codes. See NetworkSubCodes Response Container for details.	Optional
BillingMedia	Container	From Billing Media Dataset in request. See BillingMedia Response Container for details.	Optional
UsageAndCreditControl	Container	From UsageAndCreditControl Dataset in request. See UsageAndCreditControl Response Container for details.	Optional
Discounts	Container	From Discounts Dataset in request. Contains one or more Discount. See Discount Response Container for details.	Optional
Address	Container	See Address Response Container for details.	Optional
Services	Container	See Service Response Container for details.	Optional
SubscriptionBars	Container	Contains one or more Subscription Bar. The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the connection has been processed. See SubscriptionBar Response Container for details.	Optional
AttributeGroup	Container	See AttributeGroup Response Container for details.	Optional
ActiveAndPendingServices	Container	From ActiveAndPendingServices Dataset in request. This contains one or more Subscription Service(s) and returns only Active Services. See for ActiveAndPendingServices Response Container for further information.	Optional
SimProfileInformation	Container	See SIMProfileInformation Response Container for details.
TerminationFee	Container	From Termination Fee Dataset in request. See TerminationFee Container for details.	Optional
Parent	Boolean	This indicates whether or not the subscription is a parent subscription.	Optional
Features	Container	See Features Response Container for further details.	Optional
Definitions	Container	Only populate if the Definitions dataset is passed through with either or both the PACKAGES and PENDING_TARIFF_CHANGE datasets. The exact content of this container will depend on the other datasets that are returned. For instance if the PACKAGES dataset wasn’t supplied then Bolt On Packages will not be returned in this dataset. See Definitions Response Container for further details.	Optional
PendingTariffChange	Container	This dataset is returned from QuerySubscription if the PENDING_TARIFF_CHANGE dataset is supplied and there is a Tariff Change pending. See PendingTariffChange Response Container for further details.	Optional

ActiveAndPendingServices Response Container

The ActiveAndPendingServices response container has the following elements:

Element Name	Content Type	Description	Required?
Service	Container	See Service container for details.	Optional

Service

The Service response container has the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	This details the code attributed to the Service as it appears on the invoice.	Mandatory
PackageCode	String6	The code attributed to the Package. This indicates that the chosen service is part of Package, which is a combination of Services grouped together against this Subscription.	Optional
ServicePrice	Decimal	Min Inclusive - 999999999.99 Max Inclusive - 999999999.99	Optional
Description	String30	This details the short descriptive text (30-characters) attributed to the Service as it appears on the invoice.	Optional
EffectiveDate	Date	YYYY-MM-DDZ	Optional
ExpiryDate	Date	YYYY-MM-DDZ	Optional
IncdInTermCostCalc	Boolean	This indicates if a particular Service is included in the termination cost calculation.	Optional
PriceConsolidationService	String6	Applicable to Subscription Services only. This enables the chosen Service to become part of one consolidated Service, which is several chargeable Subscription Services grouped together to appear on the Subscription invoice as one Service with one charge or price against it.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional
NetworkConfirmed	Boolean	This indicates whether the Service has been confirmed by the Network.	Optional
DeleteActionStatus	String	This indicates the status of the deletion action. The possible statuses are as follows: CONFIRMED – the associated deletion Workflow Event has been confirmed at the network. ERROR – the associated deletion Workflow Eventh has errored. PENDING – the associated deletion Workflow Event has not yet completed. NONE – there is no associated deletion Workflow Event.	Optional

Address Response Container

The Address response container has the following elements:

Element Name	Content Type	Description	Required?
AddressNumber	Integer	The Subscription level delivery address number.	Optional
PersonalAddress	Container	The PersonalAddress container is returned when populated in CMP.	Optional
BusinessAddress	Container	The BusinessAddress container is returned when populated in CMP.	Optional
Last Amended Date	dateTime	The date and time at which the Subscription was last amended. YYYY-MM-DDThh:mm:ssZ	Optional

Only one address type, personal or business, can be setup at any one time. Therefore only the address which is populated in CMP is returned when an Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. is queried specifying the ADDRESS dataset.

PersonalAddress Response Container

Element Name	Content Type	Description	Required?
Title	String10	The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required.	Mandatory
Forename	String50	Customer's first name.	Optional
MiddleName	String20	Customer's middle name.	Optional
Surname	String50	Customer's surname.	Mandatory
Address1	String60	Line one of the customer's address.	Mandatory
Address2	String60	Line one of the customer's address.	Optional
Address3	String60	Line one of the customer's address.	Optional
Address4	String60	Line one of the customer's address.	Optional
Address5	String60	Line one of the customer's address.	Optional
Postcode	String10	Customer's post code. Must be entered without spaces.	Optional
DateOfBirth	Date	Customer's date of birth, in the format YYYY-MM-DD.	Optional
Gender	String	Choice of: Male, Female, Unknown or BLANK.	Optional
MaritalStatus	String	Choice of: Married, Single, Widowed, Divorced, Other, Seperated or BLANK.	Optional
DateOfResidence	Date	The date from which the customer has lived at the address specified, in the format YYYY-MM-DD.	Optional
CustomerType	String10	Selected from one of the available Customer Types configured in CMP.	Optional
AddressType	String10	Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address. Configurable CMP list.	Optional
Occupation	String10	The customer's current occupation. Configurable CMP list.	Optional
IDType	String10	The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list.	Optional
IDNumber	String30	The unique ID from the proof of identity.	Optional
TelephoneNumber	String15	Customer's main contact telephone number.	Optional
EveningTelephoneNumber	String15	Customer's additional telephone number they can be reached on.	Optional
FaxNumber	String15	Customer's fax number.	Optional

CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.

BusinessAddress Response Container

Element Name	Content Type	Description	Required?
CompanyName	String60	Name of company.	Mandatory
Address1	String40	Line one of the company's address.	Mandatory
Address2	String40	Line two of the company's address.	Optional
Address3	String40	Line three of the company's address.	Optional
Address4	String40	Line four of the company's address.	Optional
Address5	String40	Line five of the company's address.	Optional
Postcode	String10	Company's postcode. Must be entered without spaces.	Optional
CompanyTelephoneNumber	String15	Company's main contact telephone number.	Optional
ContactTelephoneNumber	String15	The individual's contact telephone number.	Optional
FaxNumber	String15	Company's fax number	Optional
CompanyType	String10	Indicates the type of company. Configurable CMP list.	Optional
AddressType	String10	Identifies the company's address. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address can be configured. Configurable CMP list.	Optional
IndustrialClassificationCode	String10	Indicates the industry the company resides.	Optional
CompanyRegistration	String25	Unique ID the company is registered to.	Optional
DateOfIncorporation	Date	The date the company register at the address specified, in the format YYYY-MM-DD.	Optional
Title	String10	Company's contact title.	Optional
Forename	String15	Company's contact first name.	Optional
MiddleName	String10	Company's contact middle name.	Optional
Surname	String25	Company's contact surname name.	Optional
JobTitle	String30	Company's contact job title.	Optional

AttributeGroup Response Container

The AttributeGroup response container has the following processing results:

Element Name	Content Type	Description	Required
AttributeGroupId	String	This unique Attribute Group Id.	Mandatory
Attribute	Container	One or more repetitions. See Attribute Response Container for details.	Optional
EffectiveDate	DateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
AttributeId	Decimal2	A unique Id for the Attribute. For example, 01. This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP back office configuration.	Mandatory
AttributeValue	String120	A full description of the Attribute. For example, Dedicated Lease Line Connection	Optional
EffectiveDate	DateTime	The date on which the Attribute becomes effective. YYYY-MM-DDThh:mm:ssZ	Optional

Element Name

Content Type

Description

Required?

AttributeId

Decimal2

A unique Id for the Attribute. For example, 01.

This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP back office configuration.

Mandatory

AttributeValue

String120

A full description of the Attribute.

For example, Dedicated Lease Line Connection

Optional

EffectiveDate

DateTime

The date on which the Attribute becomes effective.

YYYY-MM-DDThh:mm:ssZ

Optional

SubscriptionBasic Response Container

The SubscriptionBasic response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription.	Mandatory
AgreementNumber	Integer8	The CMP Agreement Number of the Subscriber.	Mandatory
AccountNumber	Integer8	CMP Account Number that the Subscriber is on.	Mandatory
CorporateCode	String6	Indicates if the Subscriber is part of a Corporate structure.	Optional
GroupCode	String6	Indicates if the Subscriber is part of a Group structure.	Optional
CompanyNumber	String3	The Company Number to be assigned to the Account. The value must already be set up in CMP.	Mandatory
SalesAccountCode	Integer8	The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the connection has been processed.	Optional
SubscriptionStatus	String	The value returned is one of the following: Disconnected Normal Number Change Pending Number Change-Waiting Order Despatch Connection Pending Connection-Waiting Order Despatch Connection-Waiting Customer Activation Future Connection Pending Disconnection Pending Future Disconnection Pending Tariff Change Pending Tariff Change-Waiting Order Despatch Tariff Change-Waiting Customer Activation Future Tariff Change Pending Number Change Pending Number Change-Waiting Order Despatch Number Change-Waiting Customer Activation Future Number Change Pending Connection Failed Disconnection Failed Tariff Change Failed Number Change Failed Network Service Pending Future Network Service Pending Network Service Failed Bar Pending Future Bar Pending Bar Failed Unbar Pending Future Unbar Pending Unbar Failed Network Activity Pending Future Network Activity Pending Network Activity Failed Not Connected	Mandatory
LastSubscriptionOrderStatus	Enumeration	Possible Values: AWAITING_ORDER_DESPATCH AWAITING_CUSTOMER_ACTIVATION COMPLETE CANCELLED This gives the status of the last order that the Subscription was associated with. This is the same as the SubsOrderStatus that is returned from QueryOrder.	Optional
PricePlanCode	String6	This is the Price Plan Code that the Subscriber is on.	Optional
TariffChangePending	Boolean	This indicates if a Tariff Change is pending. This allows the calling system to definitively know if a Tariff Change is pending. Using the Subscription Status can cause problems because of the complexity of Network Service Activity.	Mandatory
TariffCode	String6	The Tariff the Subscriber is on.	Mandatory
TariffShareGroup	String19	The Subscribers Agreement Number concatenated with the Tariff Group value from the Tariff Extension file separated by a dash, for example 12345678-TSG1.	Optional
BillingType	String8 - Enumeration	Contain one the following values: Prepaid Postpaid Hybrid	Mandatory
NetworkCode	String6	The Network Code of the network that the Subscription is on.	Mandatory
ConnectedDate	Date	This displays a date on which the Subscription is connected. YYYY-MM-DDZ	Optional
DisconnectedDate	Date	This displays a date on which the Subscription is disconnected. YYYY-MM-DDZ	Optional
TerminateOn	Date	Derived from the Subscription. Date on which the Subscription was terminated. YYYY-MM-DDZ	Optional
ConnectionReason	String4	Reason Code supplied at time of Subscriber creation.	Mandatory
AddressNumber	Integer8	The CMP Address Number for the Subscriber.	Mandatory
EmailAddress	String70	The Subscriber's email address.	Optional
Parent	Boolean	Indicates whether or not the Subscription is the parent.	Optional
LastTariffChangeEvent	Integer9	The Workflow Event Id of the last Tariff Change. This is also the Workflow Event Id of a pending Tariff Change and can be used in the UpdateWorkflow web service to cancel a pending Tariff Change.	Optional
LastNumberChangeEvent	Integer9	This is the Workflow Event Id of the last number change (any serial number change). It is also the Workflow Event Id of a pending number change. It can be used in the UpdateWorkflow webservice to cancel a pending number change.	Optional
LastConnectionEvent	Integer9	This is the Workflow Event Id of the last connection event. This is also the Workflow Event Id of a pending connection.	Optional
SuspendedFromInvoicing	Boolean	A flag indicating whether a Subscription is excluded from Invoice Production.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

BillingMedia Response Container

The BillingMedia response container has the following elements:

Element Name	Content Type	Description	Required?
BillingMediaCode	String6	The format in which the invoice is printed. Subs = Detailed bill (Itemisation) Billing Media must be a valid Billing media code that has been set up.	Optional
BillingMediaCopyInvoiceMediaCode	String6	The format in which the copy invoice is printed.	Optional
BillingMediaOverrideInvoiceMediaCode	String6	This allows for a different monthly bill design format to be applied to the specific subscription as an alternative to the format selected at the Agreement level.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

ContractAndSales Response Container

The ContractAndSales response container has the following elements:

Element Name	Content Type	Description	Required?
ContractNumber	String12	This relates to the service agreement the customer has subscribed to for a fixed period of time.	Optional
PricePlanCode	String6	Unique identifier for the Price Plan. The Price Plan details charges and services. Entering a price plan automatically attaches to the new subscription, tariff and package that were defined when the Price Plan was created.	Optional
Next Invoice Date	Date	This details the date on which the next expected invoice will be produced. YYYY-MM-DDZ	Optional
ContractStartDate	Date	If the customer is required to sign a contract on agreeing to connection the contract start date is displayed. YYYY-MM-DDZ	Optional
ContractEndDate	Date	This details the date on which the contract is due to end. This is usually 12 or 24 months after the date on which the contract was signed. YYYY-MM-DDZ This is a calculated value and is derived using the following calculation: Contract Start Date + TermOfContract + Freeze Days +CarriedOverContractDays	Optional
MinimumContractEndDate	Date	YYYY-MM-DDZ This is the minimum number of months that a subscription must be on the current contract before they are eligible for an upgrade.	Optional
TermOfContract	Integer3	This indicates he number of months over which the customer is bound by the contract terms.	Optional
CarriedOverContractDays	Integer3	'Carried over days' are added during an upgrade to allow for a scenario where a subscriber could, for example, have 23 days remaining on their contract at the time of upgrade. These days will then be added onto the new contract, so if the new contract was, for example, 24 months then the term of contract would now be 24 months and 23 days.	Optional
FreezeContractDays	Integer3	This displays the number of contracted days that the freeze will last for.	Optional
TermsAndConditionsGroupCode	String6	This details the specific terms and conditions linked to the Agreement.	Optional
TerminationInvoiceProduced	Boolean	When set to 'True' this indicates that the final closing invoice has been issued following disconnection.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

CustomerDetails Response Container

The CustomerDetails response container has the following elements:

Element Name	Content Type	Description	Required?
UserName	String30	This appears on the customer's invoice. This facility is mainly used by companies to identify who has the Subscription when the invoice is not being directly paid by the user.	Optional
SubPassword	String10	This is used for security purposes if it is necessary to control caller access.	Optional
ItemCode	String25	Details the code relative to the last sub related hardware product that was purchased by a Subscriber such as the latest handset or SIM card purchased.	Optional
DirectoryListingAllowed	Boolean	This includes or excludes the Subscription from internal directory listing, depending on whether or not it is set to True or False.	Optional
CustomerCostCentre	String20	Codes are used to allocate responsibility of charges to different areas within an organisation. The customer's own purchase ledger cost centre can be entered here and is printed on all invoices.	Optional
CustomerReference	String60	Reference number given to the customer when an order is placed.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Definitions Response Container

The Definitions response container has the following elements:

Element Name	Content Type	Description	Required?
PackageDefinition	Container	This is only populated when the PACKAGE_DEFINITION dataset is supplied in addition to the PACKAGES dataset. A PackageDefinition is returned for each different Package Code contained within the above mentioned datasets. See PackageDefinition response container for details.	Optional
PricePlanDefinitions	Container	This container will give more information about the Price Plan. It is only populated if the DEFINITIONS dataset is supplied with either the BASIC or PENDING_TARIFF_CHANGE datasets and either of those contain a PricePlanCode. For each PricePlanCode being returned in the response a PricePlanDefinition is returned. See PricePlanDefinitions response container for details.	Optional

Element Name

Content Type

Description

Required?

PackageDefinition

Container

This is only populated when the PACKAGE_DEFINITION dataset is supplied in addition to the PACKAGES dataset.

A PackageDefinition is returned for each different Package Code contained within the above mentioned datasets.

See PackageDefinition response container for details.

Optional

PricePlanDefinitions

Container

This container will give more information about the Price Plan. It is only populated if the DEFINITIONS dataset is supplied with either the BASIC or PENDING_TARIFF_CHANGE datasets and either of those contain a PricePlanCode.

For each PricePlanCode being returned in the response a PricePlanDefinition is returned.

See PricePlanDefinitions response container for details.

Optional

PackageDefinition Response Container

The PackageDefinition response container has the following elements:

Element Name	Content Type	Description	Required?
PackageCode	String5	The unique code for the Package.	Mandatory
PackageClassification	Enumeration	Possible values: Base Bolton	Mandatory
Description	String30	The short description of the Package.	Mandatory
LongDescription	String120	The full description of the Package	Optional
ToolTipText	String300	The tool tip text for the Package.	Optional
Attributes	Container	Attributes are a configurable list of values that are used to describe the Package. An example of an Attribute Name for a package would be ‘PackageType’ An example of an Attribute description (for the attribute name example given above) would be one of: Base, Boost, Promotion or Discount. See Attribute response container for details.	Optional

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
Group	String6	The group allows Attributes to be grouped together. For instance to distinguish between descriptive and rules attributes. Descriptive Attributes are just for information purposes: CMP will base logic on rule Attributes.	Mandatory
Name	String30	Attribute names are a configurable list of attributes that can be configured to meet a particular business or technical requirement.	Mandatory
Value	String120	The Value of the attribute name.	Mandatory

PricePlanDefinitions Response Container

The PricePlanDefinitions response container has the following elements:

Element Name	Content Type	Description	Required?
PricePlanCode	String6	The unique code for the Price Plan.	Mandatory
PricePlanDescription	String30	The short description of the Price Plan.	Mandatory
LongDescription	String120	The full description of the Price Plan.	Optional
ToolTipText	String300	The tool tip text for the Price Plan.	Optional
ContractTerm	Integer3	The default contract term for this Price Plan, if none has been specifically configured against the price plan, the tariff contract term is returned.	Optional
Attributes	Container	The Attributes are a configurable list of values that can be associated with a Price Plan to provide more information on it. This can be used by the consuming application for e.g. display purposes. If an Attribute of the Price Plan was a SIM Only Price plan, this could have an attribute name of PlanType and then have an Value of SIMO or Handset.	Optional

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
Group	String6	The group allows Attributes to be grouped together. For instance to distinguish between descriptive and rules attributes. Descriptive Attributes are just for information purposes: CMP will base logic on rule Attributes.	Mandatory
Name	String30	Attribute names are a configurable list of attributes that can be configured to meet a particular business or technical requirement.	Mandatory
Value	String120	The Value of the attribute name.	Mandatory

Discount Response Container

The Discount response container has the following elements:

Element Name	Content Type	Description	Required?
DiscountType	String6	Details the discount type: normal, favourite number, cross product, invoice volume or cumulative.	Mandatory
DiscountSchemeCode	String6	The unique code for the discount scheme.	Optional
DiscountDescription	String60	A long description of the discount.	Optional
EffectiveDate	Date	The date on which the discount becomes effective. YYYY-MM-DDZ	Optional
ExpiryDate	Date	The date on which the discount will expire. YYYY-MM-DDZ	Optional
PackageCode	String6	The unique code for the base package with which the discount is associated.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Features Response Container

The Features response container has the following elements:

Element Name	Content Type	Description	Required?
Feature	Container	One or more repetitions. See Feature Response Container for details.	Mandatory

Feature Response Container

The Features response container has the following elements:

Element Name	Content Type	Description	Required?
FeatureCode	String6	CMP Feature Code, unique representation of network feature within CMP.	Mandatory
FeatureDescription	String	Description of the CMP Feature Code.	Mandatory
FeatureEnabled	Boolean	Indicating if feature is enabled or not.	Mandatory
FeatureBarred	Boolean	Indicating if feature is currently barred or not.	Mandatory
FeatureActivityPending	Boolean	Indicating if there is workflow activity pending on this feature.	Mandatory
SubscriberControlled	Boolean	Indicating if this feature can be controlled by the subscriber or not.	Mandatory

PendingTariffChange Response Container

The PendingTariffChange response container has the following elements:

Element Name	Content Type	Description	Required?
PricePlanCode	String6	This field is only returned if there is a Tariff Change pending and a Price Plan has been supplied as part of the Tariff Change request. It represents the new Price Plan that will be applied.	Optional
TariffCode	String6	This field is only returned if there is a Tariff Change pending. It represents the new Tariff that will be applied.	Mandatory
PackageCode	String6	This field is only returned if there is a Tariff Change pending and a Base Package has been supplied as part of the Tariff Change request. It represents the new Base Package that will be applied.	Optional
EffectiveDate	Date	The date upon which the Tariff Change is set to occur.	Mandatory

SerialNumbers Response Container

The SerialNumbers response container has the following elements:

Element Name	Content Type	Description	Required?
SerialNumbers	Container	See SerialNumber response container for details.	Optional
NonManagedSerialNumbers	Container	See NonManagedSerialNumbers response container for details.	Optional
NetworkSubCodes	Container	See NetworkSubCodes response container for details.	Optional

SerialNumbers Response Container

The SerialNumbers response container has the following elements:

Element Name	Content Type	Description	Required?
ManagedSerialNumber	Container	One or more (up to five) repetitions. See ManagedSerialNumber Response Container for details.	Optional

ManagedSerialNumber Response Container

The ManagedSerialNumber response container has the following elements:

Element Name	Content Type	Description	Required?
EnumerationId	Range1-5	The Managed Serial Number identification number.	Mandatory
ManagedSerialNumber	String25	The actual network serial number.	Mandatory
NetworkEffectiveDate	Date	The date on which the serial number becomes effective. YYYY-MM-DDZ	Optional
NetworkCode	String6	The Network Code of the network that the Subscription is on.	Optional
NetworkSerialStatus	String - Enumeration	Choice of: CHANGING CURRENT	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

NonManagedSerialNumbers Response Container

The NonManagedSerialNumbers response container has the following elements:

Element Name	Content Type	Description	Required?
NonManagedSerialNumber	Container	One or more (up to nine) repetitions. See NonManagedSerialNumber Response Container for details.	Optional

NonManagedSerialNumber Response Container

The NonManagedSerialNumber response container has the following elements:

Element Name	Content Type	Description	Required?
EnumerationId	Range 1-9	The Non-Managed Serial Number identification number.	Mandatory
NonManagedSerialNumber	String25	This contains a configurable Non-Managed Serial Number.	Mandatory
NetworkEffectiveDate	Date	The date on which the Non-Managed Serial Number becomes effective. YYYY-MM-DDZ	Optional
NetworkSerialStatus	String - Enumeration	Choice of: CHANGING CURRENT	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

NetworkSubCodes Response Container

The NetworkSubCodes response container has the following elements:

Element Name	Content Type	Description	Required?
NetworkSubCodes	Container	Zero or more (up to two) repetitions. See NetworkSubCode Response Container for details.	Optional

NetworkSubCode Response Container

The NetworkSubCode response container has the following elements:

Element Name	Content Type	Description	Required?
EnumerationId	Range1-2	The network sub-code identification number.	Mandatory
NetworkSubCode	String10	This contains an extra code or serial number associated with the network code. This field is completely configurable depending on customer business requirements.	Mandatory
NetworkEffectiveDate	Date	The date on which the network sub-code number becomes effective. YYYY-MM-DDZ	Optional
NetworkCode	String6	The network code of the network that the subscription is on.	Optional
NetworkSerialStatus	String - Enumeration	Choice of: CHANGING CURRENT	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Services Response Container

The Services response container has the following elements:

Element Name	Content Type	Description	Required?
Service	Container	See Service response container for details.	Optional

Service Response Container

The Service response container has the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	This details the code attributed to the Service as it appears on the invoice.	Mandatory
PackageCode	String6	The code attributed to the Package. This indicates that the chosen Service is part of Package, which is a combination of Services grouped together against this Subscription.	Optional
ServicePrice	Currency (Decimal 9,2)	Min Inclusive - 999999999.99 Max Inclusive - 999999999.99	Optional
Description	String30	This details the short descriptive text (30-characters) attributed to the Service as it appears on the invoice.	Optional
LongDescription	String	This details a longer descriptive text attributed to the Service (120-characters).	Optional
EffectiveDate	Date	The date from which the Service becomes effective. YYYY-MM-DDZ	Optional
ExpiryDate	Date	The date on which the Service is set to expire. YYYY-MM-DDZ	Optional
IncdInTermCostCalc	Boolean	This indicates if a particular Service is included in the termination cost calculation.	Optional
PriceConsolidationService	String6	Applicable to Subscription Services only. This enables the chosen Service to become part of one consolidated Service, which is several chargeable Subscription Services grouped together to appear on the Subscription invoice as one Service with one charge or price against it.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

SIMProfileInformation Response Container

The SIMProfileInformation response container has the following elements:

Element Name	Content Type	Description	Required?
SIMProfileInformation	Container	See SimProfileInformation Response Container for details.	Optional

SimProfileInformation Response Container

The SIMProfileInformation response container has the following elements:

Element Name	Content Type	Description	Required?
ICCID	Integer20	The ICCID (Integrated Circuit Card Identifier) identifies each SIM internationally	Mandatory
PUK1	Integer8	This is used to reset a personal identification number (PIN) that was either lost or stolen. This is normally updated into CMP from a SIM Upload job.	Mandatory
PUK2	Integer8	This is used to reset a personal identification number (PIN) that was either lost or stolen. This is normally updated into CMP from a SIM Upload job.	Mandatory

SubscriptionBars Response Container

The SubscriptionBars response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionBar	Container	See SubscriptionBar response container for details.	Optional

SubscriptionBar Response Container

The SubscriptionBar response container has the following elements:

Element Name	Content Type	Description	Required?
NetworkCommandCode	String6	A unique code which identifies a specific network command.	Mandatory
BarredDate	dateTime	The date and time on which the bar became effective on the Subscription. YYYY-MM-DDThh:mm:ssZ	Mandatory
UnbarredDate	dateTime	This date and time is set when the Subscription bar has been removed. YYYY-MM-DDThh:mm:ssZ	Optional
BarReasonCode	String4	Code description relating to the bar reason code.	Optional
UnbarReasonCode	String4	Code description relating to the unbar reason code.	Optional
AdminBarFlag	Boolean	This indicates whether the bar was placed on the Subscription by the service administrators.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

TerminationFee Response Container

The TerminationFee response container has the following elements:

Element Name	Content Type	Description	Required?
TerminationFee	Currency (Decimal)	Amount to be charged if a Subscriber decides to leave their contract early.	Optional

UsageAndCreditControl Response Container

The UsageAndCreditControl response container has the following elements:

Element Name	Content Type	Description	Required?
LowerUsageLimit	Currency (Decimal)	A usage figure above the customer's average usage spend which, when reached, instigates an action such as warning the customer via SMS (if mobile) or by letter that the limit has been reached. Min Inclusive: 0.00 Max Inclusive: 999999999.99	Optional
UpperUsageLimit	Currency (Decimal)	A usage figure some way above the customer's average spend which, when reached, instigates an action, such as the barring of a fixed line or mobile handset. Min Inclusive: 0.00 Max Inclusive: 999999999.99	Optional
IgnoreUsageLimit	Boolean	If True, the customer is not notified when either their lower or upper usage limit is reached, and no auto response is triggered. This affects all subscriptions linked to the account.	Optional
AutoAdjust	Boolean	The system generated adjustment to usage limits based on customer spend history over three month periods.	Optional
IgnoreCreditControlProcedures	Boolean	This cancels the whole Credit Control process up to a specified date.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Sample QuerySubscription Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

      <ns2:QuerySubscriptionResponse xmlns:ns2="http://mdsuk.com/ws/dise3g/subscription/definition" xmlns:ns3="http://mdsuk.com/ws/dise3g/workflow/definition" xmlns:ns4="http://mdsuk.com/ws/dise3g/fault/exception">

<ns2:Result>

<CorporateCode>DRAXPR</CorporateCode>

<GroupCode>DRAXPR</GroupCode>

<SubscriptionStatus>Normal</SubscriptionStatus>

<EmailAddress>G.PAYNE001@MDSUK.com</EmailAddress>

</SubscriptionBasic>

<UserName>Miss Marina S Sangbaran</UserName>

<SubPassword>MDSOAMS1</SubPassword>

</CustomerDetails>

<ServiceCode>FOCITS</ServiceCode>

<Description>Int Traveller Service - Free</Description>

</Service>

<ServiceCode>LINECH</ServiceCode>

<Description>Line Rental Charge</Description>

</Service>

<Description>Multimedia Messaging Service</Description>

</Service>

<Description>Free calls to the Office</Description>

</Service>

</Services>

</Attribute>

</Attribute>

</Attribute>

</AttributeGroup>

</ReasonCodes>

</UpgradeEligibility>

</ns2:Result>

</ns2:QuerySubscriptionResponse>

</soapenv:Body>

</soapenv:Envelope>

RevertLastUpgrade

The RevertLastUpgrade SOAP web service has been deprecated.

The RevertLastUpgrade web service enables an external client system to revert a Subscriber's Tariff and Base Package back to their previous status, prior to the last Subscriber upgrade. The RevertLastUpgrade web service then invokes a Tariff Change to revert the Subscriber back onto their previous Tariff.

RevertLastUpgrade Request

The RevertLastUpgrade tag instructs the Subscription Service to revert the specified Subscription back to their previous proposition. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription.	Mandatory
AuditRecord	Container	See AuditRecord request container for details.	Optional

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserId	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The Program Name should be hard coded in the calling application to uniquely identify that application.	Mandatory

RevertLastUpgrade Response

The RevertLastUpgrade response is the response to the RevertLastUpgrade request. This contains the following elements:

Element Name	Content Type	Description	Required?
External Reference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserId	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The Program Name should be hard coded in the calling application to uniquely identify that application.	Mandatory

UpdateSubscription

The UpdateSubscription web service enables an external client system to update Subscription information for existing CMP Subscriptions.

To update the Subscription details, the user must pass in a valid CMP Subscription Number.

If more than one active Subscription exists for the Primary Serial Number submitted, an error message is returned.

Users are able to update individual attributes of the Subscription details as per the Edit Subscription screen. Invalid requests are rejected with an error message.

UpdateSubscription Request

The UpdateSubscription tag instructs the Subscription Service to update Subscription details. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionIdentifier	Integer8	Identifier to the Subscription.	Mandatory
UpdateSubscriptionBasic	Container	See UpdateSubscriptionBasic request container for details.	Optional
UpdateBillingMedia	Container	See UpdateBillingMedia request container for details.	Optional
UpdateContractAndSales	Container	See UpdateContractAndSales request container for details.	Optional
UpdateCustomerDetails	Container	See UpdateCustomerDetails request container for details.	Optional
UpdateUsageAndCreditControl	Container	See UpdateUsageAndCreditControl request container for details.	Optional

UpdateSubscriptionBasic Request Container

The UpdateSubscriptionBasic request container has the following elements:

Element Name	Content Type	Description	Required?
SalesAccountCode	Integer8	The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the connection has been processed	Optional
AddressNumber	Integer8	The address identifier of an existing CMP address	Optional
AgreementNumber	Integer8	The number automatically allocated by the system to the Agreement upon creation.	Optional
LastAmendedDate	Date	YYYY-MM-DDZ	Mandatory
ParentSubscription	Boolean	Defines whether or not the Subscription is to be set as a parent Subscription.	Optional

UpdateBillingMedia Request Container

The UpdateBillingMedia request container has the following elements:

Element Name	Content Type	Description	Required?
BillingMediaCode	String6	The format in which the invoice is printed, e.g. 'A4 paper'. Subs = Detailed bill (Itemisation) Billing Media must be a valid Billing media code that has been set up.	Optional
BillingMediaCopyInvoice	String6	The format in which the copy invoice is printed, e.g. 'A4 paper'.	Optional
Billing MediaOverrideInvoiceMediaCode	String6	This allows for a different monthly bill design format to be applied to the specific Subscription as an alternative to the format selected at the Agreement level.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateContractAndSales Request Container

The UpdateContractAndSales request container has the following elements:

Element Name	Content Type	Description	Required?
ContractNumber	String12	If a Contract Number is supplied, a Contract Start Date must also be supplied.	Optional
ContractStartDate	Container	Either of: Value - containing the new Expiry Date (Date)) - YYYY-MM-DDZ Clear - containing the string 'CLEAR_FIELD' (string 11).	Optional
TermOfContract	Interger1-999	This indicates he number of months over which the customer is bound by the Contract Terms. The term of contract can be explicitly supplied in this request. If supplied then it takes precedence over the defaulted value. If its not supplied and the Contract Start Date is supplied, then the term of contract will default from the Tariff (if configured against it) or from the Price Plan if it has been supplied in the request. The value from the Price Plan supersedes the value from the Tariff in this situation.	Optional
CarriedOverContractDays	Integer3	Carried over days are added during an upgrade to allow for a scenario where a Subscriber could, for example, have 23 days remaining on their contract at the time of upgrade. These days will then be added onto the new contract, so if the new contract was, for example, 24 months then the term of contract would now be 24 months and 23 days.	Optional
TermsAndConditionsGroupCode	String6	This details the specific terms and conditions linked to the Agreement.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateCustomerDetails Request Container

The UpdateCustomerDetails request container has the following elements:

Element Name	Content Type	Description	Required?
UserName	String30	This appears on the customer's invoice. This facility is mainly used by companies to identify who has the Subscription when the invoice is not being directly paid by the user.	Optional
SubPassword	String10	This is used for security purposes if it is necessary to control 'caller' access.	Optional
ItemCode	String25	The list of Items that is applicable are items that are configured to be subscription related. These are items that have the Subscription Related flag in set up configured to Y.	Optional
DirectoryListingAllowed	Boolean	This includes or excludes the subscription from internal directory listing, depending on whether or not it is set to 'true' or 'false'.	Optional
CustomerCostCentre	String20	The valid cost centres are configured at the agreement level of the subscription. See createAgreementCostCentres webservice	Optional
CustomerReference	String60	Reference number given to the customer when an order is placed.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateUsageAndCreditControl Request Container

The UpdateUsageAndCreditControl request container has the following elements:

Element Name	Content Type	Description	Required?
LowerUsageLimit	Currency	A usage figure above the customer's average usage spend which, when reached, instigates an action such as warning the customer via SMS (if mobile) or by letter that the limit has been reached. Min Inclusive: 0.00 Max Inclusive: 999999999.99	Optional
UpperUsageLimit	Currency	A usage figure some way above the customer's average spend which, when reached, instigates an action, such as the barring of a fixed line or mobile handset. Min Inclusive: 0.00 Max Inclusive: 999999999.99	Optional
IgnoreUsageLimits	Boolean	If 'true', this means the customer is not notified when either their lower or upper usage limit is reached, and no auto response is triggered. This affects all Subscriptions linked to the Account.	Optional
AutoAdjust	Boolean	The system generated adjustment to usage limits based on customer spend history over three month periods.	Optional
IgnoreCreditControlProcedures	Boolean	This cancels the whole Credit Control process up to a specified date (e.g one month).	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateSubscription Response

UpdateSubscription response is the response to the UpdateSubscription request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional

UpdateSubscriptionSerialNumbers

The UpdateSubscriptionSerialNumbers web service enables an external client system to update Subscription Serial Numbers in bulk for existing CMP Subscriptions, including Managed Serial Numbers, Non-Managed Serial Numbers and Network In the context of CMP, the infrastructure on which usage of registered customers will be measured – this could be a mobile phone network, broadband network or other non-telecommunications network. Sub Codes.

In order to update the Subscription Serial Number, the user must pass in a valid CMP Subscription Number.

Potentially, multiple Subscription Numbers can be changed at any one time. The user will pass through the information for the 'type' of number change(s). The user can request this information via the QuerySubscription web service, specifying the SERIALNUMBERS dataset.

If a number change is raised via the web service and the Subscription meets the criteria above, an error is sent within the response to indicate that a number change is not possible at that time.

A Subscription is connected to determine which serial numbers can be changed. A Network can be set up to have many serial numbers. The serial numbers are split into two different types: Managed Serial Numbers and Non-Managed Serial Numbers. Within each 'type', the serial number has a unique ID. For example:

Managed Serial Numbers IDs 1-5
Non-Managed Serial Numbers 1-9 (includes PIN 1 & 2)

The UpdateSubscriptionSerialNumbers web service enables any of the numbers configured against the Network to be changed (or combination of numbers) if the configuration within CMP is set up to allow them to. If a web service request for a number change is received and the CMP configuration does not allow a change for the specific number an error is sent in the response.

The validation on the serial number passed through also utilises the CMP validation rules. Each serial number that is configured has 'field validation' to determine the rules that a valid serial number must pass. The serial number (for example, a SIM Subscriber Identity Module. A smart card (electronic chip) inside a mobile phone that communicates with the network and carries an identification number unique to the owner. The SIM can also store personal data. Number) must be numeric, between 1-20 in length, and have a prefix which is configurable depending on the Network (for example, the prefix could be 63 or 64).

Once the validation has passed the number change Workflow Event is raised. This is considered a 'successful' update number change. The web service does not wait for the Workflow Event response. Dependent upon the selection in the request, either the Non-Network or Network Workflow Event is raised.

Standard CMP processing is responsible for processing and applying Workflow Events Manually or automatically created task items that drive and record activity within CMP. Sometimes referred to as Diary Events..

UpdateSubscriptionSerialNumbers Request

The UpdateSubscriptionSerialNumbers request tag instructs the Subscription Service to update serial numbers. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionIdentifier	Integer8	Identifier to the Subscription created.	Mandatory
ManagedSerialNumbers	Container	0 to 5 repetitions. See ManagedSerialNumbers request container for details.	Optional
NonManagedSerial Numbers	Container	See NonManagedSerialNumbers request container for details	Optional
NetworkSubCodes	Container	See NetworkSubCodes request container for details.	Optional
SalesAccountIdentifier	Integer8	Sales Account number of the salesperson who introduced the customer to the Service.	Optional*
SalespersonIdentifier	Integer8	ID Number of the salesperson. This is saved to the number change workflow event in the Salesperson Number field.	Optional‡
NonNetworkChange	Boolean	If set to 'true', this allows numbers to be entered without generating a network command.	Mandatory

* This is an optional field if Serial Number Management functionality is switched on.

‡ If both the SalesAccountIdentifer and SalespersonIdentifier fields are populated, they must be a valid combination, that is they are for the same person and exist on the Sales Force table

For each 'type' of number change the user must pass in the relevant information in the appropriate container(s). Although the containers are optional, at least one container must be provided.

ManagedSerialNumbers Request Container

The ManagedSerialNumbers request container has the following elements:

Element Name	Content Type	Description	Required?
ManagedSerialNumber	Container	See ManagedSerialNumber request container for details.	Optional

ManagedSerialNumber Request Container

The ManagedSerialNumber request container has the following elements:

Element Name

Content Type

Description

Required?

Range 1-5

The Id refers to the Managed Serial Number ID. Max number of of 5.

Managed Serial Numbers are configurable depending on customer business requirements.

Mandatory

SerialNumber

Container - Choice

A choice of:

Value (String25 representing a serial number)
AutoSelect

The 'Auto Select' should be used in conjunction with Serial Number Management (next available number is selected for the update).

Mandatory

NonManagedSerialNumbers Request Container

The NonManagedSerialNumbers request container has the following elements:

Element Name	Content Type	Description	Required?
NonManagedSerialNumber	Container	0-9 repetitions. See NonManagedSerialNumber request container for details.	Optional

NonManagedSerialNumber Request Container

The NonManagedSerialNumber request container has the following elements:

Element Name

Content Type

Description

Required?

Range1-9

The Id refers to the Non-Managed Serial Number number ID. Max number of 9.

Mandatory

Value

String25

This contains a configurable non-managed serial number (e.g. PUK Number, PIN Number etc.).

This field is completely configurable depending on customer business requirements.

Mandatory

NetworkSubCodes Request Container

The NetworkSubCodes request container has the following elements:

Element Name	Content Type	Description	Required?
NetworkSubCode	Container	See NetworkSubCode request container for details.	Optional

NetworkSubCode Request Container

The NetworkSubCode request container has the following elements:

Element Name

Content Type

Description

Required?

Range1-2

The Id refers to the Network Sub Code ID. Max number of 2.

Mandatory

Value

String25

This contains an extra code or serial number associated with the network code.

This field is completely configurable depending on customer business requirements.

Mandatory

UpdateSubscriptionSerialNumbers Response

UpdateSubscriptionSerialNumbers response is the response to the UpdateSubscriptionSerialNumbers request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional

UpdateTariff

The UpdateTariff web service enables an external client system to change a customer's Price Plan on their CMP Subscription. A Price Plan consists of a Tariff, a Package and a Connection Type (the latter is only relevant for a new connection).

The user must pass in a valid CMP Subscription Number and Price Plan (which can be used to specify a Tariff and base Package combination) or Tariff and Package combination to which the customer wants to transfer.

If more than one active Subscription exists for the Primary Serial Number submitted, an error message is returned.

Submission of invalid data for the above criteria results in an error message.

The default data as specified in the Tariff Change Matrix in CMP Back Office is used for the Tariff Change, for example End Network Services?.

UpdateTariff Request

The UpdateTariff tag instructs the Subscription Service to update the Subscriber's Tariff details. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionNumber	Integer8	Indicates the unique system generated Subscription Number.	Mandatory
PricePlanCode	String6	A Price Plan can be used to specify a Tariff and Base Package combination. Supplying a Price Plan Code means that neither a Tariff Code nor a Package Code are necessary as they will be defaulted in using Price Plan set up.	Optional
TariffCode	String6	It is not possible to update the Tariff to be on the same Tariff that it is already on. However, this can be overridden if the ALLOW.SAME.TARIFF system property is configured in CMP Back Office. This is mandatory if a Price Plan is not supplied. This element is deprecated, and any values supplied in the request will be ignored.	Optional
PackageCode	String6	The Package must be a valid Package for the new Tariff that has been selected. If a Package Code is not provided, the default Package Code associated with the new Tariff will be used (if configured). This element is deprecated, and any values supplied in the request will be ignored.	Optional
IgnoreDefaultPackage	Boolean	This flag determines whether or not the default Package is selected when a Package code is not provided.	Optional
NonNetworkChange	Boolean	This allows numbers to be entered without generating a network command.	Mandatory
EndBars	Boolean	This determines whether the bars will be ended if a change of Tariff occurs.	Optional
EndBarEventCode	String4	If EndBars is set to 'true' then the appropriate Workflow Event Code is required.	Optional
EndDialledOverrides	Boolean	If set to 'true' this ends any existing dialled number overrides for the chosen Subscription. This functionality helps prevent situations where a customer is transferred onto a more favourable Tariff but continues to benefit from overrides that have been set up for the superseded Tariff. The CSA is alerted of any existing Subscriber based overrides relating to dialled number or call class via a warning message.	Optional
EndCallClassOverrides	Boolean	If set to 'true' this ends any existing Call Class Overrides for the chosen subscription. This functionality helps prevent situations where a customer is transferred onto a more favourable Tariff but continues to benefit from overrides that have been set up for the superseded Tariff. Setting both 'EndDialledNumberOverrides and EndCallClassOverrides to 'true' allows all overrides for the chosen Subscription to be ended.	Optional
ManagedSerialNumbers	Container	A container for one or more Managed Serial Numbers. See ManagedSerialNumbers request container for details.	Optional
NonManagedSerialNumbers	Container	A container for one or more Non Managed Serial Numbers. See NonManagedSerialNumbers request container for details.	Optional
NetworkSubCodes	Container	A container for one or more Network Sub Codes. See NetworkSubCodes request container for details.	Optional
SalesAccountIdentifier	Integer8	Sales Account number of the salesperson who introduced the customer to the Service. Optional field if Serial Number Management is switched on.	Optional
SalespersonIdentifier	Integer8	ID Number of the salesperson. This is stored on the tariff change workflow event. If both the SalesAccountIdentifer and SalespersonIdentifier fields are populated, they must be a valid combination, that is they are for the same person and exist on the Sales Force table	Optional
UpdateContractAndSales	Container	See UpdateContractAndSales request container	Optional
AttributeGroup	Container	See AttributeGroup Request Container for details.	Optional
AsOfDate	Container Choice	One of: Date Bill Cycle See AsOfDate request container for details. This optional container allows the specification of the date on which the Tariff Change is to take place. If not supplied then the Tariff Change will take place immediately with the effective date of the Tariff Change being backdated to midnight.	Optional
AuditRecord	Container	See the AuditRecord request container for details.	Optional
LastAmendedDate	dateTime	The user obtains this value by issuing a Query Subscription request.	Mandatory

ManagedSerialNumbers Request Container

The ManagedSerialNumbers request container has the following elements:

Element Name	Content Type	Description	Required?
ManagedSerialNumber	Container	See ManagedSerialNumber request container for details.	Optional

ManagedSerialNumber Request Container

The ManagedSerialNumber request container has the following elements:

Element Name

Content Type

Description

Required?

Range 1-5

The Id refers to the Managed Serial Number ID. Max number of of 5.

Managed Serial Numbers are configurable depending on customer business requirements.

Mandatory

SerialNumber

Container - Choice

A choice of:

Value (String25 representing a serial number)
AutoSelect

The 'Auto Select' should be used in conjunction with Serial Number Management (next available number is selected for the update).

Mandatory

ManagedSerialNumbers Request Container

The ManagedSerialNumbers request container has the following elements:

Element Name	Content Type	Description	Required?
ManagedSerialNumber	Container	See ManagedSerialNumber request container for details.	Optional

ManagedSerialNumber Request Container

The ManagedSerialNumber request container has the following elements:

Element Name

Content Type

Description

Required?

Range 1-5

The Id refers to the Managed Serial Number ID. Max number of of 5.

Managed Serial Numbers are configurable depending on customer business requirements.

Mandatory

SerialNumber

Container - Choice

A choice of:

Value (String25 representing a serial number)
AutoSelect

The 'Auto Select' should be used in conjunction with Serial Number Management (next available number is selected for the update).

Mandatory

UpdateContractAndSales Request Container

The UpdateContractAndSales request container has the following elements:

Element Name	Content Type	Description	Required?
ContractNumber	String12	If a Contract Number is supplied, a Contract Start Date must also be supplied.	Optional
ContractStartDate	Container	Either of: Value - containing the new Expiry Date (Date)) - YYYY-MM-DDZ Clear - containing the string 'CLEAR_FIELD' (string 11).	Optional
TermOfContract	Interger1-999	This indicates he number of months over which the customer is bound by the Contract Terms. The term of contract can be explicitly supplied in this request. If supplied then it takes precedence over the defaulted value. If its not supplied and the Contract Start Date is supplied, then the term of contract will default from the Tariff (if configured against it) or from the Price Plan if it has been supplied in the request. The value from the Price Plan supersedes the value from the Tariff in this situation.	Optional
CarriedOverContractDays	Integer3	Carried over days are added during an upgrade to allow for a scenario where a Subscriber could, for example, have 23 days remaining on their contract at the time of upgrade. These days will then be added onto the new contract, so if the new contract was, for example, 24 months then the term of contract would now be 24 months and 23 days.	Optional
TermsAndConditionsGroupCode	String6	This details the specific terms and conditions linked to the Agreement.	Optional

Attribute Request Container

The Attribute request container has the following elements:

Element Name

Content Type

Description

Required?

AttributeGroupId

String6

A unique ID for the Attribute Group. For example, 03A.

Each account can have only a single effective Attribute Group at any one time.

Mandatory

Attribute

Container

Zero or more repetitions. See Attribute request container for details.

Optional

Attribute Request Container

The Attribute request container holds details of one particular Attribute:

Element Name

Content Type

Description

Required?

AttributeId

Decimal2

A unique Id for the Attribute. For example, 01.

This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP Back Office configuration.

Mandatory

AttributeValue

String120

A full description of the Attribute.

For example, Dedicated Lease Line Connection.

Optional

AsOfDate Request Container

The AsOfDate request container has the following elements:

Element Name

Content Type

Description

Required?

Date

This is the date on which the Tariff Change is to take place. As its optional, if its not supplied then the Tariff Change will take place immediately.

Optional

OnBillCycle

Boolean

When this is selected then Tariff Change Workflow Event will be set to process on the next bill cycle.

If the Bill Cycle is changed between when the Tariff Change was raised and the Tariff Change taking place, the Tariff Change will take place on the original Bill Cycle Date unless the Tariff ChangeTariff Change Workflow Event is updated manually in AgentView or via the UpdateWorkflow web service.

Optional

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserID	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The program name should be hard coded in the calling application to uniquely identify that application.	Mandatory

UpdateTariff Response

The UpdateTariff response is the response to the UpdateTariff request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
EventNumber	Integer9	The Tariff Change Workflow Event Number generated by CMP.	Mandatory
PackageCode	String6	The Package Code used in the Tariff update (whether supplied in the request or the default associated with the new Tariff).	Optional